Skip to content

fix: correct markdown lint flag variable names#12167

Merged
kgryte merged 3 commits into
stdlib-js:developfrom
anandkaranubc:fix/markdown-lint-pkg-readmes-flags
May 17, 2026
Merged

fix: correct markdown lint flag variable names#12167
kgryte merged 3 commits into
stdlib-js:developfrom
anandkaranubc:fix/markdown-lint-pkg-readmes-flags

Conversation

@anandkaranubc

@anandkaranubc anandkaranubc commented May 17, 2026

Copy link
Copy Markdown
Contributor

Resolves None

Description

What is the purpose of this pull request?

This pull request:

  • use correct variable for package README markdown lint flags

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

  • None

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

Used Cursor+VS Code code-generation tools to help assist with the feature.

@stdlib-js/reviewers

@anandkaranubc
fix: use correct variable for package README markdown lint flags
b5ca22f 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown_pkg_readmes
    status: na
  - task: lint_markdown_docs
    status: na
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@anandkaranubc anandkaranubc requested a review from a team May 17, 2026 06:22
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 17, 2026
@anandkaranubc

anandkaranubc commented May 17, 2026

Copy link
Copy Markdown
Contributor Author

While committing gaxpb, the linter printed the whole README instead of a short pass/fail line. Make warned about an undefined variable: the Makefile used MARKDOWN_LINT_PKG_READMES_FLAGS, but remark.mk defines MARKDOWN_LINT_FLAGS_PKG_READMES. Fixing the name applies --quiet/--no-stdout so only errors show.

cc: @kgryte @batpigandme

@anandkaranubc anandkaranubc added Bug Something isn't working. METR Pull request associated with the METR project. labels May 17, 2026
@anandkaranubc

anandkaranubc commented May 17, 2026

Copy link
Copy Markdown
Contributor Author

A similar MARKDOWN_LINT_DOCS_FLAGS/MARKDOWN_LINT_FLAGS_DOCS mismatch too.

@anandkaranubc
fix: correct markdown lint flag variable name
4184542 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown_pkg_readmes
    status: na
  - task: lint_markdown_docs
    status: na
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@anandkaranubc anandkaranubc changed the title fix: use correct variable for package README markdown lint flags fix: correct markdown lint flag variable names May 17, 2026
@kgryte

kgryte commented May 17, 2026

Copy link
Copy Markdown
Member

@anandkaranubc I suggest doing the opposite. Fix the environment variable names in remark.mk.

@kgryte

kgryte commented May 17, 2026

Copy link
Copy Markdown
Member

...meaning _FLAGS should always come last.

@anandkaranubc
chore: apply suggestions from review
50c5c6b 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown_pkg_readmes
    status: na
  - task: lint_markdown_docs
    status: na
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@anandkaranubc

anandkaranubc commented May 17, 2026

Copy link
Copy Markdown
Contributor Author

I thought so too, haha. Sorry!

@kgryte kgryte removed the Needs Review A pull request which needs code review. label May 17, 2026
@kgryte kgryte merged commit 87731b4 into stdlib-js:develop May 17, 2026
10 checks passed
@batpigandme

batpigandme commented May 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Thank you, @anandkaranubc! My bad (obviously)! 😬

Note to self I found the commit where I introduced this problem: batpigandme/stdlib@cc6c59d.

Athan asked me to change the order of the variable names to match the extant file pattern with MARKDOWN_LINT_FLAGS, and I made the change in the markdown Makefile but NOT the remark.mk

@anandkaranubc anandkaranubc deleted the fix/markdown-lint-pkg-readmes-flags branch June 21, 2026 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte kgryte approved these changes

Assignees

No one assigned

Labels

Bug Something isn't working. METR Pull request associated with the METR project.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@anandkaranubc @kgryte @batpigandme @stdlib-bot